DocInstance
The DocInstance object provides definition for the instance of the requested document. That is, the object describes a given document instance.
| Parameter | Type | Description |
|---|---|---|
| DocIDRef | string | A reference to the unique identifier (DocID) associated with a document. |
| DocData | Data | Container object for transaction data inputs and outputs in binary (base64), text, or xml format. It will include all documents in the current packet. |
| InstanceDisplayName | string | The document display name associated with the document. This is authored as part of REQ authoring (Document > Properties). The InstanceDisplayName, with any spaces and special characters removed, is used as the file name in the returned document. |
| InstanceFileName | string | The instance file name associated with the document instance. This is generated as a conversion of the dispay name (converting the display name to a file name) in a maner that replaces any special characters or spaces in the display name with an underscore (_). |
| InstanceFormattingMetadata | InstanceFormattingMetadata | Container object used to define formatting metadata for an instance. |
| InstancePacketType | string | The type of the packet associated with the instance. |
| InstancePacketName | string | The packetCountname of the packet associated with the instance. |
| InstanceDocumentRef | string | The document reference associated with the instance. |
| InstanceSequence | ExpereInteger | The sequencing of the instance (as an integer). |
| InstanceBarcodeValue | string | The barcode value associated with the instance of the document. |
| InstancePageCount | ExpereInteger | The number of pages in the instance. |
| InstanceRecordableFlag | ExpereBoolean | A boolean defining if the document, generated by the specified instance, is a recorded document. A TRUE value indicates the document is recorded; a FALSE value indicates it is non-recordable. |
| InstancePageSize | string | The size of the page generated from the specified instance. The value on the response is calculated as either Letter or Legal. The values are returned in the string in initial caps format (Legal, Letter). |
| DocFormat | DocumentFormatType | Object defining the format type for a document (based on an enumerated value): PDF specifies that output documents should be formatted as PDF.; RAW_XML specifies that output documents should be formatted as XML.; RTF specifies that output documents should be formatted as RTF (dynamic documents output as RTF, however static docs output as fillable PDFs). |
| Copy | string | The number of copies of the document associated with the instance. |
| AncillaryOutputOption | ArrayOfAncillaryOutputOption | Array containing an unbound collection of AncillaryOutputOption objects. |
| SignaturePointSet | SignaturePointSet | Object defining the Signer. |
| FillableFieldSet | FillableFieldSet | Object defining the Fillable Checkbox and FillableText field. |
| DiscretePartyIDs | DiscretePartyIDs | A string of data containing a unique discrete party ID. |